chore: update develop-2.0.0 with v2.11.2 changelog and door example#3966
Conversation
Updating changelog entry.
| /// This is a simple state driven door example. | ||
| /// This script was written with recommended usages patterns in mind. | ||
| /// </remarks> | ||
| public class Door : NetworkBehaviour, INetworkUpdateSystem |
There was a problem hiding this comment.
Does "DocumentationExamples" means actual documentation in that sense (so we would ping Amy to double check) or functions more as code pattern for users (so maybe we could change the name to something more like "CodePatterns" or remove this subfolder compleately and have it under Examples/NetworkVariable/DoorExample"
There was a problem hiding this comment.
It is a place to keep working versions of our documentation examples for two reasons:
- If you want to test an example (currently), you have to copy it, paste it into a file, setup a test specific to the example, and then verify the example works.
- The initial thought was to use this for our testing and modification purposes.
- We could eventually move these into samples, which then we can include:
- The script (or a section of the script) and then always (under the source) link to the sample or script.
Many of our examples are "too simplified" such that it can leave room for users to make assumptions which may or may not be correct... if we are very clear about the "usage pattern" then hopefully that will help provide users with a pattern that won't lead to issues down the road.
There was a problem hiding this comment.
Hmm, during Unity Talks there was a talk from Oleksandr Kokoshyn about Making code examples in Unity docs testable which I guess is what we are trying to achieve here? (Talk is not yet available but I think will be this week)
There was a problem hiding this comment.
Yeah... trying to start preparing NGO to follow a similar pattern now so it makes it easier down the road.
There was a problem hiding this comment.
What about merging this as it is for now and create task to update those in the same way
There was a problem hiding this comment.
I could have used #3959 to add the door example script... next time I will make sure to do that.
Purpose of this PR
Jira ticket
NA
Changelog
NA
Documentation
Testing & QA (How your changes can be verified during release Playtest)
Functional Testing
Manual testing :
Manual testing doneAutomated tests:
Covered by existing automated testsCovered by new automated testsDoes the change require QA team to:
Review automated tests?Execute manual tests?Provide feedback about the PR?If any boxes above are checked the QA team will be automatically added as a PR reviewer.
Backports
No back port required.